API Documentation
Scheduler.h
1 // Scheduler.h
3 //
5 
6 namespace nkTasks
7 {
13  class DLL_TASKS_EXPORT Scheduler final
14  {
15  public :
16 
24  Scheduler (size_t threadCount = 0) ;
29 
30  // Getters
34  size_t getThreadCount () const ;
39  Thread* getThread (size_t index) const ;
40 
46  void addTask (Task* task) ;
47 
55  void resolveTask (Task* task) ;
56 
62  void checkEndedTasks () ;
63 
64  // Threads
68  void joinAllThreads () ;
74  void resizeForThreadCount (size_t threadCount) ;
75  } ;
76 }
nkTasks::Thread
Symbolizes a thread. Base block to submit off-thread nkTasks::Task in this component.
Definition: Thread.h:12
nkTasks::Scheduler::resizeForThreadCount
void resizeForThreadCount(size_t threadCount)
nkTasks::Task
A task, job that can be submitted to a nkTasks::Thread.
Definition: Task.h:14
nkTasks::Scheduler::~Scheduler
~Scheduler()
nkTasks
Encompasses all API of component NilkinsTasks.
Definition: LogManager.h:7
nkTasks::Scheduler::getThreadCount
size_t getThreadCount() const
nkTasks::Scheduler::resolveTask
void resolveTask(Task *task)
nkTasks::Scheduler::joinAllThreads
void joinAllThreads()
nkTasks::Scheduler::addTask
void addTask(Task *task)
nkTasks::Scheduler::checkEndedTasks
void checkEndedTasks()
nkTasks::Scheduler::getThread
Thread * getThread(size_t index) const
nkTasks::Scheduler::Scheduler
Scheduler(size_t threadCount=0)
nkTasks::Scheduler
Allows to automate task submission to a set of threads.
Definition: Scheduler.h:14